Loading TOC...

POST /manage/v2/packages/{pkgname}/install

Summary

This resource address installs the named package (pkgname). The URI of the ticket is returned that provides the status of the install operation, along with the details of the installed resources. You can view this ticket by entering the URI in a browser.

URL Parameters
format The format of the output. This can be either xml or json. By default, the format is xml.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body, either application/zip, application/xml, or application/json.
Response Headers
Content-type The MIME type of the data in the payload body. Depending upon the value of the format parameter or Accept header, either application/xml or application/json.

Response

Upon success, MarkLogic Server returns status code 200 (OK). The response body contains the URI of the ticket.

Required Privileges

This operation requires the manage-admin role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Example


      curl -i -X POST --data-binary @/dev/null --digest -u admin:admin \
      -H "Content-type: application/xml" \
      "http://localhost:8002/manage/v2/packages/test-package/install"

      ==> Installs the configurations in the "test-package" package onto the 
          localhost.

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.